//
// * Copyright (c) 2002-2009 "Neo Technology,"
// *     Network Engine for Objects in Lund AB [http://neotechnology.com]
// *
// * This file is part of Neo4j.
// * 
// * Neo4j is free software: you can redistribute it and/or modify
// * it under the terms of the GNU Affero General Public License as
// * published by the Free Software Foundation, either version 3 of the
// * License, or (at your option) any later version.
// * 
// * This program is distributed in the hope that it will be useful,
// * but WITHOUT ANY WARRANTY; without even the implied warranty of
// * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// * GNU Affero General Public License for more details.
// * 
// * You should have received a copy of the GNU Affero General Public License
// * along with this program. If not, see <http://www.gnu.org/licenses/>.
// 
namespace org.neo4j.kernel.impl.nioneo.store
{

///
/// <summary> * A persistence window encapsulates a part of the records (or blocks) in a
/// * store and makes it possible to read and write data to those records. </summary>
/// 
	public interface PersistenceWindow
	{
///    
///     <summary> * Returns the underlying buffer to this persistence window.
///     *  </summary>
///     * <returns> The underlying buffer </returns>
///     
		Buffer getBuffer();

		Buffer getOffsettedBuffer(int id);

		int getRecordSize();

///    
///     <summary> * Returns the current record/block position.
///     *  </summary>
///     * <returns> The current position </returns>
///     
		long position();

///    
///     <summary> * Returns the size of this window meaning the number of records/blocks it
///     * encapsulates.
///     *  </summary>
///     * <returns> The window size </returns>
///     
		int size();

		void force();

		void close();
	}
}